Add API documentation to code base #44
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidallendj
added
the
not ready for review
davidallendj
added
needs review
davidallendj
changed the title
|
Most of the important functions and commands should now be documented aside from the ones that are going to be removed in the refactor. Additionally, none of the changes here should affect the current behavior or functionality of the tool. |
davidallendj
removed
the
needs review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add documentation describing how Magellan's internal API works and how it is designed. The goal is to make understanding the code base easier to follow and to convey the intentions of each design choice to new contributors. This should also allow reflecting on some of the design choices made thus far and target areas of the code that needs improvement.
Ideally, the API docs will be sufficient enough to use
go docsand generate documentation like on pkg.go.dev.